<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPHINXsys/src/shared/particle_generator/base_particle_generator.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_3dc1dabd28ba78e072d14d3fcfc90454.html">SPHINXsys</a></li><li class="navelem"><a class="el" href="dir_48ea983704c43b6d88c1fa3f4d09e369.html">src</a></li><li class="navelem"><a class="el" href="dir_0a0d9ef1793521534f0094f317758287.html">shared</a></li><li class="navelem"><a class="el" href="dir_28b7b9fe829ae2f4275face8955a48d6.html">particle_generator</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">base_particle_generator.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="base__particle__generator_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/* -------------------------------------------------------------------------*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">*                               SPHinXsys                                   *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">* --------------------------------------------------------------------------*</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">* SPHinXsys (pronunciation: s&#39;finksis) is an acronym from Smoothed Particle *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">* Hydrodynamics for industrial compleX systems. It provides C++ APIs for    *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">* physical accurate simulation and aims to model coupled industrial dynamic *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">* systems including fluid, solid, multi-body dynamics and beyond with SPH   *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">* (smoothed particle hydrodynamics), a meshless computational method using  *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">* particle discretization.                                                  *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">*                                                                           *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">* SPHinXsys is partially funded by German Research Foundation               *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">* (Deutsche Forschungsgemeinschaft) DFG HU1527/6-1, HU1527/10-1             *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">* and HU1527/12-1.                                                          *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">*                                                                           *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">* Portions copyright (c) 2017-2020 Technical University of Munich and       *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">* the authors&#39; affiliations.                                                *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">*                                                                           *</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">* Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may   *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">* not use this file except in compliance with the License. You may obtain a *</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">* copy of the License at http://www.apache.org/licenses/LICENSE-2.0.        *</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">*                                                                           *</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">* --------------------------------------------------------------------------*/</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#include &quot;base_data_package.h&quot;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="sph__data__conainers_8h.html">sph_data_conainers.h</a>&quot;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_s_p_h.html">SPH</a> {</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <span class="keyword">class </span>SPHBody;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <span class="keyword">class </span>BaseParticles;</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="keyword">class </span>In_Output;</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="class_s_p_h_1_1_particle_generator.html">   45</a></span>&#160;    <span class="keyword">class </span><a class="code" href="class_s_p_h_1_1_particle_generator.html">ParticleGenerator</a></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    {</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;        <a class="code" href="class_s_p_h_1_1_particle_generator.html">ParticleGenerator</a>() : sph_body_(NULL) {};</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;        <span class="keyword">virtual</span> ~<a class="code" href="class_s_p_h_1_1_particle_generator.html">ParticleGenerator</a>() {};</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> initialize(<a class="code" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a>* sph_body);</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> createBaseParticles(<a class="code" href="class_s_p_h_1_1_base_particles.html">BaseParticles</a>* base_particles) = 0;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;        <a class="code" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a>* sph_body_;</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    };</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="class_s_p_h_1_1_particle_generator_direct.html">   61</a></span>&#160;    <span class="keyword">class </span><a class="code" href="class_s_p_h_1_1_particle_generator_direct.html">ParticleGeneratorDirect</a> : <span class="keyword">public</span> <a class="code" href="class_s_p_h_1_1_particle_generator.html">ParticleGenerator</a></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    {</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;        <a class="code" href="class_s_p_h_1_1_particle_generator_direct.html">ParticleGeneratorDirect</a>() : <a class="code" href="class_s_p_h_1_1_particle_generator.html">ParticleGenerator</a>() {};</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;        <span class="keyword">virtual</span> ~<a class="code" href="class_s_p_h_1_1_particle_generator_direct.html">ParticleGeneratorDirect</a>() {};</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> createBaseParticles(<a class="code" href="class_s_p_h_1_1_base_particles.html">BaseParticles</a>* base_particles) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    };</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="class_s_p_h_1_1_particle_generator_reload.html">   73</a></span>&#160;    <span class="keyword">class </span><a class="code" href="class_s_p_h_1_1_particle_generator_reload.html">ParticleGeneratorReload</a> : <span class="keyword">public</span> <a class="code" href="class_s_p_h_1_1_particle_generator.html">ParticleGenerator</a></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    {</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;        std::string file_path_;</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;        <a class="code" href="class_s_p_h_1_1_particle_generator_reload.html">ParticleGeneratorReload</a>(<a class="code" href="class_s_p_h_1_1_in___output.html">In_Output</a>* in_output, std::string reload_body_name);</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;        <span class="keyword">virtual</span> ~<a class="code" href="class_s_p_h_1_1_particle_generator_reload.html">ParticleGeneratorReload</a>() {};</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> createBaseParticles(<a class="code" href="class_s_p_h_1_1_base_particles.html">BaseParticles</a>* base_particles) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    };</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclass_s_p_h_1_1_particle_generator_direct_html"><div class="ttname"><a href="class_s_p_h_1_1_particle_generator_direct.html">SPH::ParticleGeneratorDirect</a></div><div class="ttdoc">Generate particle directly from position-and-volume data.</div><div class="ttdef"><b>Definition:</b> base_particle_generator.h:61</div></div>
<div class="ttc" id="aclass_s_p_h_1_1_particle_generator_reload_html"><div class="ttname"><a href="class_s_p_h_1_1_particle_generator_reload.html">SPH::ParticleGeneratorReload</a></div><div class="ttdoc">Generate particle by reloading particle position and volume.</div><div class="ttdef"><b>Definition:</b> base_particle_generator.h:73</div></div>
<div class="ttc" id="asph__data__conainers_8h_html"><div class="ttname"><a href="sph__data__conainers_8h.html">sph_data_conainers.h</a></div><div class="ttdoc">Set up of basic data structure.</div></div>
<div class="ttc" id="aclass_s_p_h_1_1_base_particles_html"><div class="ttname"><a href="class_s_p_h_1_1_base_particles.html">SPH::BaseParticles</a></div><div class="ttdoc">Particles with essential (geometric and kinematic) data. There are three types of particles， all part...</div><div class="ttdef"><b>Definition:</b> base_particles.h:65</div></div>
<div class="ttc" id="aclass_s_p_h_1_1_particle_generator_html"><div class="ttname"><a href="class_s_p_h_1_1_particle_generator.html">SPH::ParticleGenerator</a></div><div class="ttdoc">Base abstract class for particle generation.</div><div class="ttdef"><b>Definition:</b> base_particle_generator.h:45</div></div>
<div class="ttc" id="aclass_s_p_h_1_1_s_p_h_body_html"><div class="ttname"><a href="class_s_p_h_1_1_s_p_h_body.html">SPH::SPHBody</a></div><div class="ttdoc">SPHBody is a base body with basic data and functions. Its derived class can be a real fluid body,...</div><div class="ttdef"><b>Definition:</b> base_body.h:63</div></div>
<div class="ttc" id="aclass_s_p_h_1_1_in___output_html"><div class="ttname"><a href="class_s_p_h_1_1_in___output.html">SPH::In_Output</a></div><div class="ttdoc">The base class which defines folders for output, restart and particle reload folders.</div><div class="ttdef"><b>Definition:</b> in_output.h:63</div></div>
<div class="ttc" id="anamespace_s_p_h_html"><div class="ttname"><a href="namespace_s_p_h.html">SPH</a></div><div class="ttdef"><b>Definition:</b> solid_body_supplementary.cpp:9</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
